////////////////////////////////////////////////////////////////////////////////
// Copyright 2010 Michael Schmalle - Teoti Graphix, LLC
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
// http://www.apache.org/licenses/LICENSE-2.0 
// 
// Unless required by applicable law or agreed to in writing, software 
// distributed under the License is distributed on an "AS IS" BASIS, 
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and 
// limitations under the License
// 
// Author: Michael Schmalle, Principal Architect
// mschmalle at teotigraphix dot com
////////////////////////////////////////////////////////////////////////////////

package org.teotigraphix.swizplugin.api
{

import org.teotigraphix.swizplugin.registry.IExtensionDescriptor;

/**
 * The <strong>IExecutableRequest</strong> interface allows the caller to request 
 * a class definition asynchronously.
 * 
 * @author Michael Schmalle
 * @copyright Teoti Graphix, LLC
 * @productversion 1.0
 */
public interface IExecutableRequest
{
	//--------------------------------------------------------------------------
	//
	//  Properties
	//
	//--------------------------------------------------------------------------
	
	//----------------------------------
	//  descriptor
	//----------------------------------
	
	/**
	 * The <code>IExtensionDescriptor</code> that owns this request.
	 * 
	 * <p>In most cases this property should not be null.</p>
	 */
	function get descriptor():IExtensionDescriptor;
	
	/**
	 * @private
	 */
	function set descriptor(value:IExtensionDescriptor):void;
	
	//----------------------------------
	//  data
	//----------------------------------
	
	/**
	 * Optional additional data to make availible for the responders.
	 */
	function get data():Object;
	
	/**
	 * @private
	 */
	function set data(value:Object):void;
	
	//----------------------------------
	//  isBean
	//----------------------------------
	
	/**
	 * Whether the instance should be treated as a Swiz Bean.
	 */
	function get isBean():Boolean;
	
	/**
	 * @private
	 */
	function set isBean(value:Boolean):void;
	
	//----------------------------------
	//  autoCreate
	//----------------------------------
	
	/**
	 * Whether the instance should be created from the type.
	 */
	function get autoCreate():Boolean;
	
	/**
	 * @private
	 */
	function set autoCreate(value:Boolean):void;
	
	//----------------------------------
	//  instance
	//----------------------------------
	
	/**
	 * The requested <code>Object</code> instance, <code>null</code> if not.
	 */
	function get instance():Object;
	
	//----------------------------------
	//  type
	//----------------------------------
	
	/**
	 * The requested <code>Class</code> reference, <code>null</code> if not.
	 */
	function get type():Class;
	
	function addListener(result:Function, fault:Function):void;
}
}